Получение лимита департамента на поездки

Запрос позволяет получить лимит департамента на поездки в сервисе Такси.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/departments/limits/taxi?department_id={идентификатор департамента}

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

  • department_id — идентификатор департамента, по которому изменяется лимит.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле

Описание

Формат

budget

Сумма, которую департамент может потратить в месяц на поездки в сервисе Такси. Значение null означает, что лимита на стоимость поездок в месяц нет.

Число

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/departments/limits/taxi?department_id=87e823515f8a4f5a45dab0298c0f646c
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "budget": 1000
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
  • 401 — был передан неверный OAuth-токен.
  • 403:
    • SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
  • 404 — департамента с указанным department_id не существует.